Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(bindings/c): update docs for CMake replacing #5186

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

PragmaTwice
Copy link
Member

@PragmaTwice PragmaTwice commented Oct 16, 2024

Which issue does this PR close?

None.

Rationale for this change

After #5182, we need to update docs to reflect our new changes.

What changes are included in this PR?

  • update README and CONTRIBUTING of C binding.
  • replace .a .so by more generalized variables.

Are there any user-facing changes?

None.

@PragmaTwice PragmaTwice changed the title doc(bindings/c): update docs for CMake replacing docs(bindings/c): update docs for CMake replacing Oct 16, 2024

- To format the code, you need to install **clang-format**

- The `opendal.h` is not formatted by hands when you contribute, please do not format the file. **Use `make format` only.**
- If your contribution is related to the files under `./tests`, you may format it before submitting your pull request. But notice that different versions of `clang-format` may format the files differently.

- **GTest(Google Test)** need to be installed to build the BDD (Behavior Driven Development) tests. To see how to build, check [here](https://github.com/google/googletest).
Copy link
Member Author

@PragmaTwice PragmaTwice Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users don't need to manually install/build GTest by themselves now.

Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thank you for working on this @PragmaTwice!

@Xuanwo Xuanwo merged commit 9f5f3ce into apache:main Oct 16, 2024
35 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants